docs: Helm as primary install method on ClickStack OTel collector page#126
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: Helm as primary install method on ClickStack OTel collector page#126mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Ports ClickHouse/clickhouse-docs#6337 — reorganizes the ClickStack OTel collector page so Helm is the primary install path, with Docker preserved in secondary tabs.
Changes
products/clickstack/ingesting-data/collector.mdx:Managed ClickStackandOpen Source ClickStackouter tabs, added intro paragraphs explaining that the official ClickStack Helm chart embeds the upstreamopentelemetry-collectorchart as a subchart, and added nestedHelm(default) /Dockertabs. Helm tabs showhelm repo add, a focusedvalues.yaml(imagedocker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0, OTLP ports,extraEnvsforCLICKHOUSE_*, plusOPAMP_SERVER_URLandHYPERDX_API_KEYfor OSS), andhelm install. Shared environment-variable guidance moved outside the nested tabs.Helm/Dockertabs (extraEnvs+helm upgradevsexport+docker run).Helm/Dockertabs, withOTLP_AUTH_TOKENadded viaextraEnvson the Helm side.#configuring-the-collector,#modifying-otel-collector-configuration[-managed],#configuring-managed-clickstack,#configuring-clickhouse-instance,#docker-compose-otel[-managed],#securing-the-collector,#creating-an-ingestion-user[-oss]).Context
Docusaurus → Mintlify port of ClickHouse/clickhouse-docs#6337. Slug
/use-cases/observability/clickstack/ingesting-data/otel-collectoris preserved. Transforms applied:<Tabs groupId>/<TabItem value label default>→<Tabs>/<Tab title>,:::note→<Info>, image imports →<Image img="..."/>,/use-cases/observability/clickstack/...→/products/clickstack/...for in-repo links. Docker Compose blocks, OSS Securing (OpAMP) prose, and the_extending_configsnippet are unchanged, matching the upstream PR.Notes / ambiguities
/products/cloud/guides/sql-console/connection-detailsin the Mintlify file (upstream uses/cloud/guides/sql-console/gather-connection-details); preserved the existing Mintlify mapping.Note
Low Risk
Documentation-only changes to collector deployment guidance; no application, auth, or ingestion code is modified.
Overview
The ClickStack OTel collector doc (
collector.mdx) is reorganized so Helm is the primary install path for Kubernetes, with Docker kept in secondary tabs.For both Managed and Open Source flows, Deploying the collector now opens with Helm chart context (ClickStack chart vs upstream
opentelemetry-collectorwith the ClickStack image), then nested Helm / Docker tabs:helm repo add, samplevalues.yaml(clickstack-otel-collectorimage, OTLP ports,extraEnvsforCLICKHOUSE_*; OSS addsOPAMP_SERVER_URLandHYPERDX_API_KEY),helm install, and guidance to use secrets viaextraEnvsFrom. Shared env-var notes sit outside the nested tabs.Modifying configuration and Securing the collector (Managed) are split the same way: Helm shows
extraEnvs+helm upgrade; Docker keepsexport+docker run(includingOTLP_AUTH_TOKENon the secure path). Existing section anchors and unchanged blocks (Docker Compose, OSS OpAMP securing,_extending_config) are preserved.Reviewed by Cursor Bugbot for commit cd2b24d. Bugbot is set up for automated code reviews on this repo. Configure here.